home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 201-225 / disk_217 / sonixpeek / sonixpeek.doc < prev    next >
Text File  |  1992-05-06  |  5KB  |  133 lines
  1.  
  2.      SONIXPEEK(1)          AMIGA Programmer's Manual           SONIXPEEK(1)
  3.  
  4.  
  5.  
  6.      ›1mNAME 
  7.           ›0mSonixPeek - lists instruments in Aegis Sonix scores 
  8.  
  9.      ›1mSYNOPSIS 
  10.           ›0mSonixPeek {-h} {-i} {-n} {-ofile} {-xdirectory} file ...  
  11.  
  12.      ›1mDESCRIPTION 
  13.           ›0mSonixPeek  is  a  utility designed to make it easier to move
  14.           score files from the Aegis Sonix music package from one disk
  15.           to another.  The problem arises because a single Sonix score
  16.           can  use  many  different  instruments,  and  all  of  these
  17.           instruments  must  be moved along with the score file to the
  18.           new disk.  
  19.  
  20.           The filename you give SonixPeek should  be  the  name  of  a
  21.           Sonix score  file.    If  you  don't  specify any additional
  22.           options, it just scans that file building a list of all  the
  23.           instruments  found,  and  then  outputs  this  list  to  the
  24.           screen.  
  25.  
  26.           If you specify a directory instead of a file, then SonixPeek
  27.           scans all the score files in that directory, building a list
  28.           of instruments in each file.  When it's finished, it outputs
  29.           this list, minus duplicates.  This lets you see the  minimum
  30.           set of instruments you need to have available to play all of
  31.           those scores.  
  32.  
  33.           You  can  include more than one file and/or directory on the
  34.           command line.  In this case, all the files  and  directories
  35.           included are scanned.  
  36.  
  37.           SonixPeek has a number of options which can be used to alter
  38.           its behaviour.  These are as follows: 
  39.  
  40.           -h  Normally, SonixPeek outputs a header at the start of the
  41.               list of instruments, showing which files the instruments
  42.               come from.    This  option  stops  the header from being
  43.               printed.  
  44.  
  45.           -i  This option makes SonixPeek prompt you for  confirmation
  46.               for  each  score  file  it  finds,  before including its
  47.               instruments in the instrument list.  This is  useful  if
  48.               you  have a directory containing a large number of score
  49.               files, and you want to find out the instruments in about
  50.               half of them, since it saves you  having  to  type  each
  51.               name out seperately.  
  52.  
  53.           -n  SonixPeek  normally  prints  out a list of files scanned
  54.               and  instruments  found  as  it  is  building  the  main
  55.               instrument list (unless only a single file was specified
  56.               on the command line).  This option suppresses the list.  
  57.  
  58.           -oF This  option  makes  SonixPeek  output the final list of
  59.               instruments to the file F, rather than standard  output.
  60.               This  provides  an  alternative  to redirecting standard
  61.               output with >F. There is a small difference between  the
  62.               two  however  -  the  list  of  files  mentioned  in the
  63.  
  64.  
  65.      Copyright Eddy Carroll 1989      -1-
  66.  
  67.  
  68.      SONIXPEEK(1)          AMIGA Programmer's Manual           SONIXPEEK(1)
  69.  
  70.  
  71.               discussion of -n is always sent to standard  output,  so
  72.               using -o has no effect on it.  
  73.  
  74.           -xD This  option  can  be  used  to help simplify moving the
  75.               instruments for a set of scores to another disk.    When
  76.               specified,  SonixPeek outputs a script file suitable for
  77.               use with AmigaDOS's EXECUTE command.  This  script  file
  78.               copies  all  the  instruments  for  the files scanned to
  79.               directory D.  Before  executing  the  script  file,  you
  80.               should  change  your  current directory to the directory
  81.               where all the instrument files are stored.  
  82.  
  83.           You can get a brief summary  of  the  options  available  by
  84.           invoking SonixPeek  with  no parameters.  CTRL-C can be used
  85.           to abort SonixPeek at any time.  
  86.  
  87.      ›1mCAVEATS 
  88.           ›0mThere is one small problem with the  automatic  script  file
  89.           facility.   Aegis  Sonix  supports two kinds of instruments,
  90.           synthesised and sampled.  Both types are stored in a  .instr
  91.           file,  but  sampled  instruments also have an associated .ss
  92.           file.  Since SonixPeek has no way of knowing whether a given
  93.           instrument  is  sampled  or  synthesised,  it  doesn't  know
  94.           whether there is a .ss file that needs to be copied.  
  95.  
  96.           The  solution  is  less than elegant but it works; SonixPeek
  97.           assumes that ALL instruments have a .ss file, and  sets  the
  98.           failat level for the script file such that any copy commands
  99.           which fail  don't  make  the  script  file  abort.  The only
  100.           alternative  to  this  would  be  to  allow  an   instrument
  101.           directory to be specified as an option, and it would then be
  102.           possible to  determine  what type each instrument was.  This
  103.           seems too much like hard work :-) 
  104.  
  105.      ›1mAUTHOR 
  106.           ›0mEddy Carroll 
  107.           The Old Rectory, 
  108.           Delgany, Co. Wicklow, 
  109.           Ireland.  
  110.  
  111.           EMAIL: ecarroll@cs.tcd.ie 
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.      Copyright Eddy Carroll 1989      -2-
  132.  
  133.